[38;2;249;38;114m.[0m[3;38;2;102;217;239mTH[0m[38;2;248;248;242m [0m[38;2;166;226;46mRUSTDOC[0m[38;2;248;248;242m [0m[38;2;230;219;116m"[0m[38;2;230;219;116m1[0m[38;2;230;219;116m"[0m[38;2;248;248;242m [0m[38;2;230;219;116m"[0m[38;2;230;219;116m<INSERT DATE HERE>[0m[38;2;230;219;116m"[0m[38;2;248;248;242m "rustdoc <INSERT VERSION HERE>" "User Commands"[0m
[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46mNAME[0m
[38;2;248;248;242mrustdoc [0m[38;2;190;132;255m\-[0m[38;2;248;248;242m generate documentation from Rust source code[0m
[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46mSYNOPSIS[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mB[0m[38;2;248;248;242m [0m[1;38;2;249;38;114mrustdoc[0m
[38;2;248;248;242m[[0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mOPTIONS[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m] [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mINPUT[0m[38;2;249;38;114m\fR[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46mDESCRIPTION[0m
[38;2;248;248;242mThis tool generates API reference documentation by extracting comments from[0m
[38;2;248;248;242msource code written in the Rust language, available at[0m
[38;2;248;248;242m<[0m[38;2;249;38;114m\fB[0m[1;38;2;249;38;114mhttps://www.rust-lang.org[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m>. It accepts several input formats and[0m
[38;2;248;248;242mprovides several output formats for the generated documentation.[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46mOPTIONS[0m

[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mr[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114minput[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mformat[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFORMAT[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mrust[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mw[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114moutput[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mformat[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFORMAT[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mhtml[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mo[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114moutput[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mOUTPUT[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m,[0m
[38;2;248;248;242mwhere to place the output (default: [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mdoc/[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m for html)[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mpasses[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mLIST[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mspace[0m[38;2;190;132;255m\[hy][0m[38;2;248;248;242mseparated list of passes to run (default: '')[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mno[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mdefaults[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mdon't run the default passes[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mplugins[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mLIST[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mspace-separated list of plugins to run (default: '')[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mplugin[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mpath[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mDIR[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mdirectory to load plugins from (default: [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112m/tmp/rustdoc_ng/plugins[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m)[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mtarget[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mTRIPLE[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mtarget triple to document[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcrate[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mname[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mNAME[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mspecify the name of this crate[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mL[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mlibrary[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mpath[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mDIR[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mdirectory to add to crate search path[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcfg[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mSPEC[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mpass a [0m[38;2;249;38;114m\fI[0m[3;38;2;190;132;255m\-[0m[3;38;2;190;132;255m\-[0m[3;38;2;228;46;112mcfg[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m to rustc[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mextern[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mVAL[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mpass an [0m[38;2;249;38;114m\fI[0m[3;38;2;190;132;255m\-[0m[3;38;2;190;132;255m\-[0m[3;38;2;228;46;112mextern[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m to rustc[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mtest[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mrun code examples as tests[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mtest[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114margs[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mARGS[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mpass arguments to the test runner[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mhtml[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114min[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mheader[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILE[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mfile to add to <head>[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mhtml[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mbefore[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcontent[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILES[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mfiles to include inline between <body> and the content of a rendered Markdown[0m
[38;2;248;248;242mfile or generated documentation[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mmarkdown[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mbefore[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcontent[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILES[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mfiles to include inline between <body> and the content of a rendered[0m
[38;2;248;248;242mMarkdown file or generated documentation[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mhtml[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mafter[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcontent[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILES[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mfiles to include inline between the content and </body> of a rendered[0m
[38;2;248;248;242mMarkdown file or generated documentation[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mmarkdown[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mafter[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcontent[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILES[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mfiles to include inline between the content and </body> of a rendered[0m
[38;2;248;248;242mMarkdown file or generated documentation[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mmarkdown[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcss[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mFILES[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mCSS files to include via <link> in a rendered Markdown file Markdown file or[0m
[38;2;248;248;242mgenerated documentation[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mmarkdown[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mplayground[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114murl[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mURL[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mURL to send code snippets to[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mmarkdown[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mno[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mtoc[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mdon't include table of contents[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mh[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mextend[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mcss[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mto redefine some css rules with a given file to generate doc with your own theme[0m
[38;2;249;38;114m.[0m[38;2;249;38;114mTP[0m
[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mV[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m, [0m[38;2;249;38;114m\fB[0m[1;38;2;190;132;255m\-[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mversion[0m[38;2;249;38;114m\fR[0m
[38;2;248;248;242mPrint rustdoc's version[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"OUTPUT FORMATS"[0m

[38;2;248;248;242mThe rustdoc tool can generate output in an HTML format.[0m

[38;2;248;248;242mIf using an HTML format, then the specified output destination will be the root[0m
[38;2;248;248;242mdirectory of an HTML structure for all the documentation.[0m
[38;2;248;248;242mPages will be placed into this directory, and source files will also[0m
[38;2;248;248;242mpossibly be rendered into it as well.[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"EXAMPLES"[0m

[38;2;248;248;242mTo generate documentation for the source in the current directory:[0m
[38;2;248;248;242m    $ rustdoc hello.rs[0m

[38;2;248;248;242mList all available passes that rustdoc has, along with default passes:[0m
[38;2;248;248;242m    $ rustdoc [0m[38;2;190;132;255m\-[0m[38;2;190;132;255m\-[0m[38;2;248;248;242mpasses list[0m

[38;2;248;248;242mThe generated HTML can be viewed with any standard web browser.[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"SEE ALSO"[0m

[38;2;249;38;114m.[0m[38;2;249;38;114mBR[0m[38;2;248;248;242m [0m[1;38;2;249;38;114mrustc[0m[38;2;248;248;242m (1)[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"BUGS"[0m
[38;2;248;248;242mSee <[0m[38;2;249;38;114m\fB[0m[1;38;2;249;38;114mhttps://github.com/rust[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mlang/rust/issues[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m>[0m
[38;2;248;248;242mfor issues.[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"AUTHOR"[0m
[38;2;248;248;242mSee the version control history or <[0m[38;2;249;38;114m\fB[0m[1;38;2;249;38;114mhttps://thanks.rust[0m[1;38;2;190;132;255m\-[0m[1;38;2;249;38;114mlang.org[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m>[0m

[38;2;249;38;114m.[0m[3;38;2;102;217;239mSH[0m[38;2;248;248;242m [0m[38;2;166;226;46m"COPYRIGHT"[0m
[38;2;248;248;242mThis work is dual[0m[38;2;190;132;255m\[hy][0m[38;2;248;248;242mlicensed under Apache[0m[38;2;190;132;255m\ [0m[38;2;248;248;242m2.0 and MIT terms.[0m
[38;2;248;248;242mSee [0m[38;2;249;38;114m\fI[0m[3;38;2;228;46;112mCOPYRIGHT[0m[38;2;249;38;114m\fR[0m[38;2;248;248;242m file in the rust source distribution.[0m
